home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / gt_power / escrub03.zip / ESCRUB.DOC < prev    next >
Text File  |  1989-12-15  |  6KB  |  135 lines
  1.  
  2. ESCRUB
  3. ------
  4. The ESCRUB program is used to process the messages from an echo conference
  5. looking for entries to the echolist.  These fragments of a echolist must
  6. be in the Echolist Format as shown below, otherwise ESCRUB will not "see"
  7. them.  P&M Software Co. is sponsoring a Echolist Echo Conference, the
  8. conference designation is E01/007.  It may be obtained from 009/000 in
  9. Phoenix and many other GT systems.  Local coordinators are urged to post
  10. changes to their echolists in this conference.
  11.  
  12. When ESCRUB processes a message area, the message can appear as normal,
  13. but ESCRUB will automatically scan for entries of the proper echolist format.
  14. Text that does not match this format will be ignored.
  15.  
  16. The Echolist format is compatible with the ECOxxx.LOG format maintained by
  17. the ECOxxx.COM programs.
  18.  
  19. Here is the command line format:
  20.  
  21.     ESCRUB   pathname   output
  22.  
  23.     Sample usage:    ESCRUB  d:\echo_eco  eco_work
  24.  
  25. Where:
  26.  
  27.     pathname ....... The pathname of the message area to be scrubbed for
  28.                      echolist entries.  The 'pathname' *must* point to the
  29.                      top level directory for the desired message area.
  30.  
  31.                      The GTMSGS sub-directory in this area should be sorted
  32.                      prior to invokation of ESCRUB.  The Norton 'ds' command
  33.                      can be used, for example:
  34.  
  35.                                DS  NE  C:\ECHO_ECO\GTMSGS
  36.  
  37.                      Please note that 'pathname' *must* not contain the
  38.                      '\GTMSGS' as shown for 'ds'.
  39.  
  40.     output ......... The file that will be created with the result of the
  41.                      scrubbing of the message area.  Duplicate entries will
  42.                      have been removed prior to writing this file, with
  43.                      precedence given the later entries --- the reason for
  44.                      the directory sort prior to scrubbing.  This file is
  45.                      ready for input to EMERGE as a 'new_echolist' or command
  46.                      line parameter #1.
  47.  
  48. Here is an example batch file, showing the usage of ESCRUB and EMERGE together.
  49.  
  50.     escrub c:\echo_eco  eco1
  51.     sort  <c:\gt\echolist.bbs >eco2
  52.     emerge eco1 eco2 out
  53.     del eco1
  54.     del eco2
  55.  
  56. Where:
  57.  
  58.     c:\echo_eco ...... The pathname of the echo conference where the echolist
  59.                        fragments are published.  The id of the conference
  60.                        sponsored by P&M Software Co. for this purpose is
  61.                        E01/007.  It may be obtained from 009/000 in Phoenix,
  62.                        and from many other GT systems.
  63.  
  64.     sort ............. The DOS filter.  The program is supplied with DOS
  65.                        version 3.0+.  It is used here to insure that the
  66.                        input files are in conference number order.
  67.  
  68.     emerge ........... The program that will reconcile two echolists, producing
  69.                        a consolidated final output.
  70.  
  71.     eco1 ............. Temporary work files.  They are deleted when no longer
  72.     eco2               required.
  73.  
  74.     out .............. The final output file.  May be installed as your
  75.                        working echolist or chained into further runs of
  76.                        EMERGE, when more than 1 source of echolist is to be
  77.                        processed.
  78.  
  79. Echolist Format
  80. ---------------
  81. The following is a sample echolist:
  82.  
  83. E00/001  GT POWER Support                               009/000 01:00-06:00
  84. E01/007  The ECHOLIST                                   009/000 01:00-06:00
  85. E01/008  The NODELIST                                   009/000 01:00-06:00
  86.  
  87.            Column      Contents
  88.            ------      --------
  89.             1-3        Echo Series.  Ranges from E00-E99.
  90.                        Please note that with the advent of G bags and this
  91.                        new way of maintaining echolists, only E99 conferences
  92.                        will be considered 'local'.  This should be quite
  93.                        adequate for any net, 1,000 local conferences.
  94.  
  95.              4         '/'.  Constant.
  96.  
  97.             5-7        Conference number. Ranges from 000-999.
  98.  
  99.              8         Restriction code:
  100.  
  101.                             'p' .... Private conference.  Usually by
  102.                                      invitation only.
  103.                             'a' .... Adult material.  Do not expose to minors.
  104.                             'g' .... GT Sysops only.  Others not welcome.
  105.                             's' .... Sensitive subject matter.  Be careful who
  106.                                      gets to read it.
  107.                             ' ' .... Blank - no restriction.
  108.  
  109.              9         Normally blank.  Will be set by EMERGE to '·' as a
  110.                        change marker.
  111.  
  112.             10-55      Conference description.
  113.  
  114.              56        Blank.  Constant.
  115.  
  116.             57-59      Net number of sponsor.  Must be in range 000-999.
  117.  
  118.              60        '/'.  Constant.
  119.  
  120.             61-63      Node number of sponsor.  Must be in range 000-999.
  121.  
  122.              64        Blank.  Constant.
  123.  
  124.             65-75      The time when the conference is available on the
  125.                        sponsors system.  The format is unrestricted, but is
  126.                        usually a range of hours in the Central Standard Time
  127.                        Zone of the U.S.A.
  128.  
  129.              76-?      Data following the time is not significant.  So comments
  130.                        might be added.
  131.  
  132. All files processed by ESCRUB and EMERGE must adhere to this format.  Otherwise
  133. the echolist will be malformed.
  134.  
  135.